<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Returns a result set listing the index and statistics for a table</title>
 </head>
 <body class="docs"><div id="layout">
  <div id="layout-content"><div id="function.db2-statistics" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">db2_statistics</h1>
  <p class="verinfo">(PECL ibm_db2 &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">db2_statistics</span> &mdash; <span class="dc-title">
   Returns a result set listing the index and statistics for a table
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.db2-statistics-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>db2_statistics</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$qualifier</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$schema</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$table-name</code></span>
   , <span class="methodparam"><span class="type">bool</span> <code class="parameter">$unique</code></span>
   ) : <span class="type">resource</span></div>


  <p class="para rdfs-comment">
   Returns a result set listing the index and statistics for a table.
  </p>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.db2-statistics-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    
     <dt>
<code class="parameter">connection</code></dt>

     <dd>

      <p class="para">
       A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
      </p>
     </dd>

     
    
     <dt>
<code class="parameter">qualifier</code></dt>

     <dd>

      <p class="para">
       A qualifier for DB2 databases running on OS/390 or z/OS servers. For
       other databases, pass <strong><code>NULL</code></strong> or an empty string.
      </p>
     </dd>

     
    
     <dt>
<code class="parameter">schema</code></dt>

     <dd>

      <p class="para">
       The schema that contains the targeted table. If this parameter is
       <strong><code>NULL</code></strong>, the statistics and indexes are returned for the schema of the
       current user.
      </p>
     </dd>

     
    
     <dt>
<code class="parameter">table_name</code></dt>

     <dd>

      <p class="para">
       The name of the table.
      </p>
     </dd>

     
    
     <dt>
<code class="parameter">unique</code></dt>

     <dd>

      <p class="para">
       An integer value representing the type of index information to return.
       <dl>

        
         <dt>
<code class="parameter">0</code></dt>

         <dd>

          <p class="para">
           Return only the information for unique indexes on the table.
          </p>
         </dd>

        
        
         <dt>
<code class="parameter">1</code></dt>

         <dd>

          <p class="para">
           Return the information for all indexes on the table.
          </p>
         </dd>

        
       </dl>

      </p>
     </dd>

     
   </dl>

  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.db2-statistics-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   Returns a statement resource with a result set containing rows describing
   the statistics and indexes for the base tables matching the specified
   parameters. The rows are composed of the following columns:
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Column name</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>TABLE_CAT</td>
       <td>The catalog that contains the table. The value is <strong><code>NULL</code></strong> if
       this table does not have catalogs.</td>
      </tr>

      <tr>
       <td>TABLE_SCHEM</td>
       <td>Name of the schema that contains the table.</td>
      </tr>

      <tr>
       <td>TABLE_NAME</td>
       <td>Name of the table.</td>
      </tr>

      <tr>
       <td>NON_UNIQUE</td>
       <td>
        <p class="para">
         An integer value representing whether the index prohibits unique
         values, or whether the row represents statistics on the table itself:
         <table class="doctable informaltable">
          
           <thead>
            <tr>
             <th>Return value</th>
             <th>Parameter type</th>
            </tr>

           </thead>

           <tbody class="tbody">
            <tr>
             <td>0 (SQL_FALSE)</td>
             <td>The index allows duplicate values.</td>
            </tr>

            <tr>
             <td>1 (SQL_TRUE)</td>
             <td>The index values must be unique.</td>
            </tr>

            <tr>
             <td><strong><code>NULL</code></strong></td>
             <td>This row is statistics information for the table itself.</td>
            </tr>

           </tbody>
          
         </table>

        </p>
       </td>
      </tr>

      <tr>
       <td>INDEX_QUALIFIER</td>
       <td>A string value representing the qualifier that would have to be
       prepended to INDEX_NAME to fully qualify the index.</td>
      </tr>

      <tr>
       <td>INDEX_NAME</td>
       <td>A string representing the name of the index.</td>
      </tr>

      <tr>
       <td>TYPE</td>
       <td>
        <p class="para">
         An integer value representing the type of information contained in
         this row of the result set:
         <table class="doctable informaltable">
          
           <thead>
            <tr>
             <th>Return value</th>
             <th>Parameter type</th>
            </tr>

           </thead>

           <tbody class="tbody">
            <tr>
             <td>0 (SQL_TABLE_STAT)</td>
             <td>The row contains statistics about the table itself.</td>
            </tr>

            <tr>
             <td>1 (SQL_INDEX_CLUSTERED)</td>
             <td>The row contains information about a clustered index.</td>
            </tr>

            <tr>
             <td>2 (SQL_INDEX_HASH)</td>
             <td>The row contains information about a hashed index.</td>
            </tr>

            <tr>
             <td>3 (SQL_INDEX_OTHER)</td>
             <td>The row contains information about a type of index that
             is neither clustered nor hashed.</td>
            </tr>

           </tbody>
          
         </table>

        </p>
       </td>
      </tr>

      <tr>
       <td>ORDINAL_POSITION</td>
       <td>The 1-indexed position of the column in the index. <strong><code>NULL</code></strong> if
        the row contains statistics information about the table itself.</td>
      </tr>

      <tr>
       <td>COLUMN_NAME</td>
       <td>The name of the column in the index. <strong><code>NULL</code></strong> if the row
        contains statistics information about the table itself.</td>
      </tr>

      <tr>
       <td>ASC_OR_DESC</td>
       <td>
        <em>A</em> if the column is sorted in ascending order,
        <em>D</em> if the column is sorted in descending order,
        <strong><code>NULL</code></strong> if the row contains statistics information about the table
        itself.
       </td>
      </tr>

      <tr>
       <td>CARDINALITY</td>
       <td>
        <p class="para">
         If the row contains information about an index, this column contains
         an integer value representing the number of unique values in the
         index.
        </p>
        <p class="para">
         If the row contains information about the table itself, this column
         contains an integer value representing the number of rows in the
         table.
        </p>
       </td>
      </tr>

      <tr>
       <td>PAGES</td>
       <td>
        <p class="para">
         If the row contains information about an index, this column contains
         an integer value representing the number of pages used to store the
         index.
        </p>
        <p class="para">
         If the row contains information about the table itself, this column
         contains an integer value representing the number of pages used to
         store the table.
        </p>
       </td>
      </tr>

      <tr>
       <td>FILTER_CONDITION</td>
       <td>Always returns <strong><code>NULL</code></strong>.</td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 

 <div class="refsect1 seealso" id="refsect1-function.db2-statistics-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="db2_column_privileges.html" class="function" rel="rdfs-seeAlso">db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</span></li>
    <li class="member"><span class="function"><a href="db2_columns.html" class="function" rel="rdfs-seeAlso">db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</span></li>
    <li class="member"><span class="function"><a href="db2_foreign_keys.html" class="function" rel="rdfs-seeAlso">db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</span></li>
    <li class="member"><span class="function"><a href="db2_primary_keys.html" class="function" rel="rdfs-seeAlso">db2_primary_keys()</a> - Returns a result set listing primary keys for a table</span></li>
    <li class="member"><span class="function"><a href="db2_procedure_columns.html" class="function" rel="rdfs-seeAlso">db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</span></li>
    <li class="member"><span class="function"><a href="db2_procedures.html" class="function" rel="rdfs-seeAlso">db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</span></li>
    <li class="member"><span class="function"><a href="db2_special_columns.html" class="function" rel="rdfs-seeAlso">db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</span></li>
    <li class="member"><span class="function"><a href="db2_table_privileges.html" class="function" rel="rdfs-seeAlso">db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</span></li>
    <li class="member"><span class="function"><a href="db2_tables.html" class="function" rel="rdfs-seeAlso">db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</span></li>
   </ul>
  </p>
 </div>


</div></div></div></body></html>